home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / omniedit.arc / OMNI.TXT < prev   
Text File  |  1985-11-02  |  42KB  |  894 lines

  1.     If this is your first time here,           To see  the rest    of  the    manual,
  2.     read this  entire screen  before           use the cursor  movement    keys at
  3.     proceding.                       the  right   of    the   keyboard,
  4.                            numbered    1 to 9.     The up    or down
  5.                            keys,  8     or  2,     will  get  you
  6.     OmniEdit allows:                   through the manual.  You    may try
  7.                            the others to see  what they do,
  8.     - reading and changing DOS files           or  wait     until you  read  about
  9.                            them  later.    Push  the   keys
  10.     - simple calculations               marked Caps  Lock, Num  Lock and
  11.                            Scroll Lock until the letters C,
  12.     - elementary word processing           N  and  S   disappear  from  the
  13.                            bottom screen line.   If    you get
  14.     - talking to other computers           stuck, push Esc twice to    resume.
  15.       through a    telephone line.
  16.                            As you read about each function,
  17.     - easy rearrangement of text by           try it.     Your changes are  to a
  18.       captures.                       temporary  copy of  the    manual,
  19.                            and  you      can  start   over  by
  20.                            repeating what  you just     did to
  21.                            get here.
  22.  
  23.     Copyright 1985 by Robert T McQuaid.                          i
  24.     OmniEdit                                   Contents
  25.  
  26.  
  27.     The    preceding paragraphs appear first on the screen    for new    users.
  28.  
  29.  
  30.     Contents
  31.  
  32.     Introductory Screen       .    .    .      .    .    .     .     i
  33.     Contents     .    .       .    .    .      .    .    .     .     1
  34.     Editing     .    .       .    .    .      .    .    .     .     2
  35.        Panic Button
  36.        Cursor Movement
  37.        Editing functions
  38.        Miscellaneous
  39.        Word processing
  40.        Page numbering
  41.        Accidental deletion
  42.     Function menu     .       .    .    .      .    .    .     .     3
  43.     Communication     .       .    .    .      .    .    .     .     4
  44.        Loading the UART    
  45.        Dialing the Telephone
  46.        Transmitting text
  47.        Uploading and Downloading Files
  48.     Starting OmniEdit .       .    .    .      .    .    .     .     5
  49.     Status line     .    .       .    .    .      .    .    .     .     6
  50.     Command Summary   .       .    .    .      .    .    .     .     7
  51.     Operating Considerations    .    .      .    .    .     .     8
  52.     Glossary     .    .       .    .    .      .    .    .     .     9
  53.  
  54.     Copyright 1985 by Robert T McQuaid.                     page 1
  55.     OmniEdit                                Editing
  56.  
  57.  
  58.     OmniEdit lets you examine and change DOS text files.
  59.  
  60.  
  61.      ======================== Panic    Button =========================
  62.  
  63.     The    Esc key    will get from anywhere to  the function    menu, or to the    editing
  64.     screen, and    then shuttle between the two.    Use this key to    escape when you
  65.     get    trapped.
  66.  
  67.  
  68.      ======================= Cursor    Movement =======================
  69.  
  70.     During editing you see 23 lines of    text with a white rectangular cursor to
  71.     show where    you are    working.   You may move    the  cursor around in  the text
  72.     using keys for that    purpose    on the keyboard.  With practice, you can get to
  73.     any    place in even the largest text in a few    seconds.
  74.  
  75.     key          function
  76.  
  77.     left  (4)
  78.     right (6)      Move the cursor left or right.   It may move beyond the right
  79.           end of a line.  When it moves     off the end of    the screen, the
  80.           whole    screen scrolls to make room for    it.
  81.  
  82.     up      (8)
  83.     down  (2)      Move the cursor up or    down one  line.     When the r flag is on,
  84.           set by the End key, these keys  keep the cursor at the end of
  85.           each line.
  86.  
  87.     Home  (7)
  88.     End      (1)      Move the cursor to the beginning or  end of the line,    or when
  89.           already there, to the    beginning or end of the    screen,    or when
  90.           already there,  to the  beginning or    end of    the neighboring
  91.           screen.  End turns  on the r flag on the  bottom screen line,
  92.           alerting you    that the meaning  of the  up and down  keys has
  93.           changed.  Most other cursor keys turn    r off.
  94.  
  95.     PgUp  (9)
  96.     PgDn  (3)      Scroll the  screen up    or down,  provided the cursor  does not
  97.           leave    the screen.
  98.  
  99.     Ctrl-Home
  100.     Ctrl-End      Move the cursor to the beginning or end of the section.
  101.  
  102.     Tab        
  103.     Shift-Tab      Move the cursor right     or left to the    next tab  stop.     Tab is
  104.           the key just above Ctrl.
  105.  
  106.     Ctrl-F1      Set a    literal    search word.
  107.  
  108.     Ctrl-F2      Set an English search    word.
  109.  
  110.     Ctrl-F4      Move the word    or number at the cursor    to the search word.
  111.  
  112.     F3          Advance the cursor to    the next occurrence of the search word.
  113.           For a    literal     word, marked between triangles     on the    screen,
  114.           F3 looks  for    an  exact match.   For an  English word,  shown
  115.           between dots,     F3 stops  when    finding     the required  word, in
  116.           upper     or  lower case,  without  any    letters    or  digits  for
  117.           neighbors.
  118.  
  119.           For example, to find the next     occurrence of the word    cursor,
  120.           push Ctrl-F2,    type in    cursor,    then push the enter key    and F3.
  121.  
  122.  
  123.       =====================    Editing    functions =====================
  124.  
  125.     OmniEdit responds to the typewriter    keys in     the middle of your keyboard by
  126.     putting each typed character into the text.      These    keys let you make other
  127.     changes to your text:
  128.  
  129.     Ins          Reverse overstrike mode, as shown by    an o flag at the bottom
  130.           of  the  screen.   In    overstrike  mode  keyed     in  characters
  131.           replace text,     instead of  lengthening the  line.  Overstrike
  132.           mode goes off    when you leave the line    you are    editing.
  133.  
  134.     Del          Remove the character    at the cursor position,     shortening the
  135.           line.
  136.  
  137.     Enter      Split    a line    into two, the first composed of     the part ahead
  138.           of the cursor, the second composed of    the rest.  When    writing
  139.           new text, Enter  has the customary effect of going  on to the
  140.           next line.
  141.  
  142.     backspace      Remove the  character    to the    left of    the  cursor, shortening
  143.           the line.   When the cursor  is at  the beginning of    a line,
  144.           backspace joins it to    the end    of the one above, reversing the
  145.           Enter    key.  This is the key labeled with the left arrow, just
  146.           above    the Enter key.
  147.  
  148.     Ctrl-F6      Restore  the cursor  line  to    its  state  before the    current
  149.           changes.  The     e flag     on the    bottom    screen line  alerts you
  150.           when you may use this    key.
  151.  
  152.     You    may capture an area  or    a set of lines (but not    both  at the same time)
  153.     with the function keys.  A capture shows on    the screen in reverse and moves
  154.     with the cursor until  you deposit or discard it.  To  avoid confusion with
  155.     ordinary editing,  the smallest area capture  is two characters.   When you
  156.     have a  capture, you  can not type    in or delete  any text.
  157.  
  158.     Ctrl-PgUp
  159.     Ctrl-PgDn      Capture the line  with the cursor, or    the one     above or below
  160.           the  current    captured  block.   After   you    have  used  the
  161.           Ctrl-left or    Ctrl-right to capture a     part of a  line, these
  162.           keys expand the captured area    into a rectangle.
  163.  
  164.     Ctrl-left
  165.     Ctrl-right      Capture the character     at the    cursor and the one  to its left
  166.           or right.
  167.  
  168.     Ctrl-F9      Capture an entire section, an    area between section marks.
  169.  
  170.     Del    or +      Deposit  the capture    in the    text at     its current  position,
  171.           reverting to normal editing.
  172.  
  173.     -          Deposit the capture in the text  at its current position, but
  174.           keep    it captured  as    well.    This  allows you  to copy  text
  175.           easily.
  176.  
  177.     Ctrl-F5      Discard the captured area or lines.
  178.  
  179.     F2          This brings up the calculator.   Use the Help    calculator menu
  180.           function to learn  the keys recognized.  The    calculator uses
  181.           Polish  organization.     Using    the  rectangular captures,  you
  182.           should be able to get    column    totals of figures like these in
  183.           a few     seconds.  Just    capture    a  whole column, push  F2, hold
  184.           down + until all numbers are added, push backspace and Esc.
  185.  
  186.                    income    expenses     profit
  187.           1st quarter        41223    25771      15452
  188.           3rd quarter        44256    29104      15152
  189.           4th quarter        46218    31442      14776
  190.           2nd quarter        47128    28401      18727
  191.           full year
  192.  
  193.     You    can  enter any character  into your text by  holding down the  Alt key,
  194.     typing its    value on  the numeric  pad and    releasing Alt.     Bear in  mind,
  195.     though, that if you    save your text and read    it again later,    characters with
  196.     values 8, 10, 12, 13 and 26    will be    interpreted as controls.
  197.  
  198.  
  199.      ======================= Word processing =======================
  200.  
  201.     With these keys you    can tidy your paragraphs, shift    words between lines, or
  202.     line up the    right margins.    OmniEdit finds a paragraph the same way    you do,
  203.     without using  any hidden markers.    To  give you control, OmniEdit    marks a
  204.     paragraph before tidying it.  If you do  not like the way OmniEdit has read
  205.     the    paragraph you may change your mind before tidying.
  206.  
  207.     F7          Mark a  paragraph.  If you like  the way OmniEdit  treats the
  208.           paragraph, use the  F9 or F10    key to tidy  it, otherwise move
  209.           the cursor  out of the paragraph  to get rid of  the marking.
  210.           The paragraph    starts with the    first character    to the right of
  211.           the  cursor.    In  this  paragraph,  for example,  the     cursor
  212.           should be between  F7    and Mark when  you use F7.  All     of the
  213.           lines    after the first    have to    start  in the same column to be
  214.           marked.  A ruler  at the bottom of the screen     shows the left
  215.           and right margins and    first line  indentation    to be used when
  216.           the paragraph    is tidied.  The    margins    come from the first two
  217.           lines    only,  so if you  don't    like  what you see,  change the
  218.           first    two lines  and use F7 again,  or use F7    on  a paragraph
  219.           you like, then come back and do F8.
  220.  
  221.     F8          Mark a paragraph, but    keep the margins from the last F7.  The
  222.           margins show on the ruler at    the bottom of the screen.  When
  223.           OmniEdit can not recognize a paragraph  or could not tidy it,
  224.           F8 does nothing.
  225.  
  226.     F9          Tidy a marked    paragraph by putting  as many words as possible
  227.           on each line.
  228.  
  229.     F10          Tidy a marked    paragraph and put in enough spaces to align the
  230.           right    margin.
  231.  
  232.     F5          Put a    section    mark after the cursor line.
  233.  
  234.  
  235.     Copyright 1985 by Robert T McQuaid.                     page 2
  236.     OmniEdit                              Function Menu
  237.  
  238.  
  239.  
  240.     A function    menu appears  on the  screen when  you push  the Esc  key while
  241.     editing, or    when  there is no text.      Another sub-menu appears in  a corner
  242.     when you push  F1 or the PrtSc  key    (without shift)    while  editing.     To use
  243.     one    of the functions,  move    the cursor to the one you want    with the up and
  244.     down cursor    keys, over the 2 and 8    keys, then push    the Enter key.    For the
  245.     functions  with options,  move the    cursor into  the option     with the  four
  246.     cursor control  keys, 8,  4, 6  and    2 on  the numeric  pad,    then  set their
  247.     values with     the + and  - keys.  For  the options  requiring you to     key in
  248.     text, such as file names or    page context, the typewriter keys append to it,
  249.     and    backspace  erases the last character.    Nothing    will take  effect until
  250.     you    push Enter.  The functions are:
  251.  
  252.     Exit to DOS        End    OmniEdit.
  253.  
  254.     Discard text    This throws     away the  text.  When    you have  made changes,
  255.             OmniEdit asks  for confirmation,  to avoid    discarding your
  256.             work by mistake.
  257.  
  258.     Save text        Put    the  text back in  the edit  file.  Pushing +  with the
  259.             cursor at the left allows you  to save the file and    discard
  260.             it or exit    to DOS at the  same time.  When    you  change the
  261.             file name  you must     end it     with enter,  or OmniEdit  will
  262.             ignore  it.     When  the file     name has  the extension  .tab,
  263.             OmniEdit compresses    the file by using tab characters in the
  264.             manner accepted by DOS.
  265.  
  266.     Enter new text  You    may  type in a file  name here,    which becomes  the edit
  267.             file name.    Pushing     Enter allows you to start  a file from
  268.             scratch.
  269.  
  270.     Set    file name   When you already have a text file, this lets you change its
  271.             name.  The name is ignored unless you push enter.
  272.  
  273.     Directory        This shows    a list of  files on  a disk.  At  the directory
  274.             display,  you may  select a     file  you want     with the  four
  275.             cursor movement  keys, and the function  with + or    -.  The
  276.             Enter  key carries    out the     function.  The     read and  edit
  277.             functions  both read  the contents    of the    file into  your
  278.             text, but  only edit retains  the name  of the file     in the
  279.             lower right    corner of the screen, so you can save it later.
  280.             Using read when you    already    have text combines the new file
  281.             with the old just after the    cursor line.  OmniEdit can read
  282.             squeezed files, and    you will see the unsqueezed form on the
  283.             screen.
  284.  
  285.             The    line at     the top gives the current  directory.    You can
  286.             change  it     by  pointing    the  cursor   at  one    of  the
  287.             sub-directory names,  the ones indented one     character, and
  288.             pushing enter.
  289.  
  290.     Load UART        Refer to the communications    section    for this function.
  291.  
  292.     Print text        Pushing Enter here    prints the text.  You  can specify some
  293.             options on this  menu line and the one below.   Port is the
  294.             DOS    name of    the printer to use.  Pitch and weight determine
  295.             the     print mode.   OmniEdit    does  not  allow variations  of
  296.             print mode    within a  document, such  as printing  selected
  297.             words in boldface.    It can print  only to the IBM, Epson or
  298.             Panasonic  printers.   If  you  have  some    other  kind  of
  299.             printer, we    suggest    that you write your text to a file, and
  300.             print it with a utility for    that printer.
  301.  
  302.             Lines per  page is    the number  of lines  actually used  by
  303.             OmniEdit, paper  length is    the length  of the  paper.  The
  304.             difference between these two numbers is the    amount of blank
  305.             paper left over the    page fold.
  306.  
  307.     Help        The    option allows you to select  a topic, and the Enter key
  308.             shows you a     small amount of text on the  topic.  The light
  309.             bulb  lets you  read your  notes  in the  dark.  (How  many
  310.             programmers    does it    take to    change a light bulb?)
  311.  
  312.     Novice help        Display this manual,  provided the file omni.txt  is in the
  313.             current directory.
  314.  
  315.     Profile        A profile saves the    options    for the    screen,    the printer and
  316.             communications.   In  a  later run    of  OmniEdit,  you  can
  317.             retrieve them all at once.    To  save them, set the function
  318.             on the  Profile line to save  and push enter.   To retrieve
  319.             them later use the load function.    The profile is saved in
  320.             omni.prf, and is loaded whenever OmniEdit starts.
  321.  
  322.     screen        You    can change the colors used  for    the menu, the edit file
  323.             text, the status line, help    screens    and the    column headings
  324.             including  marked paragraphs.   The    first  option lets  you
  325.             tell OmniEdit  what    kind of    screen    you have.  Set    this to
  326.             steady for    the best performance, if  you can.  On    the IBM
  327.             color graphics  adapter, you will  see snow    on  the    screen.
  328.             Setting the     blink option turns  the screen    off  during the
  329.             refresh, removing the  snow    at the expense    of blinking the
  330.             screen.  The color graphics    adapter    can not    accomodate data
  331.             at the rate    written    by OmniEdit.  The clock    option lets you
  332.             put    a  time    of day    clock on  the bottom screen  line.  The
  333.             clock stops    when  you push Ctrl, Alt, or  either Shift key,
  334.             to avoid upsetting pop-up software.
  335.  
  336.  
  337.     The    rest of    the functions appear only on the sub-menu.
  338.  
  339.     Transmit        Refer to the communication section.
  340.  
  341.     Search        With this function you can set the search word to a    literal
  342.             or English value.  Refer to    the F3 key for the use of these
  343.             words.  When you  select global change OmniEdit  requests a
  344.             replacement     word,    then  changes all  occurrences    of  the
  345.             search word    to the replacement.   In a single operation you
  346.             can    change all instances of    "Constantinople" to "Istanbul".
  347.             When  the replacement  word     is  short, OmniEdit  asks  for
  348.             confirmation before    changing the text.  The    search word and
  349.             replacement    word may contain characters other than letters,
  350.             such as  spaces, so    this function  may do more  than simple
  351.             word replacement.  The changes  occur throughout a section.
  352.             To change  a limited  region, put  section marks  around it
  353.             first.
  354.  
  355.     Paginate        Paginate puts page markers in a section to prepare the file
  356.             for    printing.   Each page gets a  heading, as much    text as
  357.             will fit, and a footing.  Any  old page markers, with their
  358.             neighboring    headings and footings,    are removed first.  The
  359.             cursor must     start between section    marks (the F5  key puts
  360.             them in).  OmniEdit    treats the lines from the first    section
  361.             mark to  the next  null line (one  with no    characters, not
  362.             even spaces) as the    heading, and  treats the lines from the
  363.             last null line to the ending section mark as the footing.
  364.  
  365.             Page  size    is  the     number     of lines  to  use  on    a  page
  366.             (excluding the blank lines over the    page fold)
  367.  
  368.             The    context    tells OmniEdit to  put consecutive page    numbers
  369.             in    the  headings or  footings.   You  give    some  words  or
  370.             characters just before or after a page number, and OmniEdit
  371.             looks for that pattern.  Within  the pattern, OmniEdit puts
  372.             the    correct    page  number on    every page.   OmniEdit gets the
  373.             page number    by counting from the  beginning    of the file, so
  374.             it is best to paginate your    sections from first to last.
  375.     
  376.             The    context    should have just one number in it.  If one side
  377.             of the  context has     a space, the  page number  will expand
  378.             toward that     side when it gets  larger.  The number     in the
  379.             context, normally 1,  is assigned to the first  page in the
  380.             text.  If OmniEdit    does not like the context  you type in,
  381.             it will disappear when you move the    cursor to another line.
  382.  
  383.             Here are some examples of how  the page context works, with
  384.             <> marking the side    with blank spaces:
  385.  
  386.             context          bcd 001 efg      bcd 01 efg <>    <> -5-
  387.             old    heading         abcd  17 efgh    abcd 17 efg h     a-17-b
  388.             OmniEdit puts in:
  389.             page 1         abcd   1 efgh    abcd 1 efg  h     a -5-b
  390.             page 10         abcd  10 efgh    abcd 10 efg h     a-14-b
  391.             page 100         abcd 100 efgh    abcd 100 efgh     a104-b
  392.             page 1000         abcd 000 efgh    abcd 1000    efh     a004-b
  393.  
  394.             To print this manual, push F1  to get to the sub-menu, move
  395.             the    cursor    to Paginate, then  right to context.   Type the
  396.             characters page 1, leaving a space    to the left of the word
  397.             page, seven     typed in  characters in  all.    Get  the cursor
  398.             into  the contents    section     and push  F1  again, move  the
  399.             cursor to paginate and push     enter.     Repeat    F1 and Paginate
  400.             until the cursor reaches the end  of the text.  Push Esc to
  401.             get    the main menu, move the    cursor to Print    and push Enter.
  402.  
  403.     Recapture        This  enables you  to undo    your  mistakes,    within    limits.
  404.             Recapture  deletion    recovers,  in captured    form, the  last
  405.             lines you deleted  with the    Ctrl-F5    key.   Recapture edited
  406.             line creates  a one     line capture  containing the  previous
  407.             form of the    last line changed by OmniEdit.
  408.  
  409.     Capture        This  option  appears  when    you  enter  the     sub-menu  with
  410.             captured lines.  You may edit the capture to:
  411.  
  412.             - Sort the captured    lines in ascending or descending order.
  413.               The sort    key begins at the  column where    the  cursor was
  414.               before making the    capture.
  415.  
  416.             - Center lines,  or    align them at  a uniform left  or right
  417.               margin,  or truncate  them by  removing trailing    spaces.
  418.               The  margin is  the column  where    the  cursor was     before
  419.               making the capture.
  420.  
  421.             - Change the  letters in the  capture to upper  case, lower
  422.               case, or the opposite case.
  423.  
  424.     Section        Capture captures the  entire section, the same  as Ctrl-F9.
  425.             Concondance    creates    a list showing how many    times each word
  426.             in the current section is used.  The concordance goes in to
  427.             the    text at    the end    of the section.
  428.  
  429.     Capture        This appears when you have captured    lines.    The two    options
  430.             select the function    to apply to the    captured region.
  431.  
  432.     Capture.sort    This function arranges  the    captured lines in  ascending or
  433.             descending order.  For an area  capture, the sorting key is
  434.             the    entire line, for captured lines, the sorting key begins
  435.             at the  column where  the cursor was  when the  capture was
  436.             started.
  437.  
  438.     Capture.align   Align center centers each line, align left or right    adds or
  439.             removes enough spaces to line up  the left or right    edge of
  440.             each captured line,    align  truncate    removes    trailing spaces
  441.             from the capture.  For an area capture, the    margins    are the
  442.             left and right  edges of the capture.   For    captured lines,
  443.             the    margin    of align  left and  align right     is the     column
  444.             where the cursor was when  the capture started, the    margins
  445.             of align center are    those of the last paragraph marked with
  446.             F7.
  447.  
  448.     Capture.case change
  449.             This changes all  letters in the capture to     upper case, to
  450.             lower case,    or to the  opposite case.  Other characters are
  451.             unchanged.
  452.     
  453.     Xmodem        This appears  only when communication  is in  progress.  To
  454.             use    it, ask     the computer at the  other end    of the    line to
  455.             start an Xmodem transfer.  When it    tells you to start, get
  456.             to this menu function, key in the file name    and push enter.
  457.             You    will  return to    the editing  screen, where you    may use
  458.             OmniEdit  while the     Xmodem     transfer  takes place    in  the
  459.             background.     An  x flag at the  bottom of the  screen tells
  460.             you     that  Xmodem  is  running, and     the  block  and  retry
  461.             counters replace the  line and column numbers.   When the x
  462.             disappears,    you may    resume with the    Transmit menu function.
  463.  
  464.     Directory        During communication, this option  appears on the sub-menu.
  465.             From the directory,    you can     switch    sub-directories, or use
  466.             the    send  function on  a file,  causing it    to be  uploaded
  467.             using the background Xmodem    protocol.
  468.  
  469.  
  470.  
  471.     Copyright 1985 by Robert T McQuaid.                     page 3
  472.     OmniEdit                              Communication    
  473.  
  474.  
  475.     OmniEdit lets you transmit files to     another computer through the telephone
  476.     system.  To    use this  facility, your computer must have a  modem inside, or
  477.     an external    modem connected    to a serial port.
  478.  
  479.  
  480.        ====================     Loading the UART  ====================
  481.  
  482.     You    must tell your    computer to use    the same protocol  used    by the computer
  483.     at the other end of    the line.  This    is done    in part    by loading registers in
  484.     an integrated circuit chip called a    UART, which is part of the serial port.
  485.  
  486.     To get started, you    have to    set the    menu options on    the Load UART line then
  487.     push enter to get them into    the UART  itself.  If you forget to push enter,
  488.     the    options    will disappear when you    move  the cursor to another line.  This
  489.     area is complicated, because  there    are a lot of different    ways of    using a
  490.     communication line.     The options are:
  491.  
  492.     operating mode  Off    means you are not using    communications,    modem means you
  493.             have a modem  on the line, and  loop means you want     to run
  494.             the    UART  in its  own loop    mode, so  anything you    send is
  495.             received back immediately.    You won't see any other    options
  496.             until you set this to modem     or loop.  Loop    is slow    because
  497.             it will does not use interrupts.
  498.  
  499.     port        This determines which of the  two possible serial ports you
  500.             want to use.
  501.  
  502.     baud        This is the    number of bits per  second to send on the line.
  503.             It must match the capacity of  your    modem.
  504.  
  505.     frame size        The    number of data bits per    character.
  506.  
  507.     parity        The    possiblilites here are:
  508.               none  parity bit omitted
  509.               even  parity bit sent, number of one bits    sent is    even
  510.               odd   parity bit sent, number of one bits    sent is    odd
  511.               one   parity bit set to one
  512.               zero  parity bit set to zero
  513.  
  514.     stop bits        One    or two,    determines the number of one bits following the
  515.             data and parity.
  516.  
  517.     The    most  common protocol  in use by  microcomputers is  1200 baud,     8 data
  518.     bits, no parity  and one stop bit,    and that is what  OmniEdit starts with.
  519.     After you have loaded  the UART successfully, you may use  the profile save
  520.     function, so that the next time you    run OmniEdit, it knows what you    want.
  521.  
  522.  
  523.      ===================  Dialing the Telephone  ===================
  524.  
  525.     Next you must make    the phone connection.  This can    be  done by dialing the
  526.     phone by hand before attaching it to  the computer,    but with a modem having
  527.     dial capability, it    is simpler to have the modem dial the phone for    you.
  528.     
  529.     To keep OmniEdit as     flexible as possible, no modem    commands  are built in,
  530.     but    it is  easy to send commands to     a smart modem.     To talk  to the modem,
  531.     use    the Transmit function  of the sub-menu (the one    you  bring up with F1).
  532.     If you don't see  Transmit there, you forgot to load the  UART.  A letter t
  533.     on the lower screen    line tells you that  your keystrokes will now go to the
  534.     modem.  Characters returning  from the modem go into your  text, and appear
  535.     on the screen.  To get the modem to     dial the phone, look up the command in
  536.     your modem manual and type it in.  For example, to get the Hayes Smartmodem
  537.     to call  dial-a-joke from a     pulse dial  phone (not    touch-tone),  enter the
  538.     command:
  539.  
  540.        ATDP 1(212)976-3838
  541.  
  542.     As soon as    the computer finishes dialing,    pick up    your telephone    to hear
  543.     today's joke.
  544.  
  545.     When calling  another computer, the     modem will  detect a carrier  from the
  546.     other computer and switch to sending your characters to the    other computer,
  547.     instead of treating    them a modem command.
  548.  
  549.     Since it  is tedious  to key  in modem  commands, you  may keep  a file  of
  550.     commands.  Capture lines with your modem and log on    commands before    you use
  551.     transmit.  The  first capture  line    is  sent immediately  to the  modem (or
  552.     other computer) and     other lines are sent one  at a    time when  you push the
  553.     Del    key.  You may push other keys while your capture is waiting to be sent,
  554.     and    they  will be  transmitted.  All replies  from the  modem go  into your
  555.     text, and appear on    the screen.  It    is possible to store the modem commands
  556.     and    the  entire log    on  sequence for a bulletin  board in a     file.    Capture
  557.     this block and transmit it,    and you    can  log on by pushing only the    Del key
  558.     a few times.
  559.  
  560.     For    the Hayes Smartmodem, here are the  most useful    commands.  Refer to the
  561.     Hayes manual for the complete set.
  562.  
  563.     AT        This should     be the    first thing  transmitted on a command  line, to
  564.         tell the modem to take it as a command.  It    must be    in upper case.
  565.  
  566.     D        Dial the phone.  Follow  it    with a P or T  (for pulse or touch-tone
  567.         dialing), and the phone number, in which the punctuation characters
  568.         ( )    - space    are ignored.  A    comma causes a two second pause.
  569.  
  570.  
  571.       ====================    Transmitting text  =======================
  572.  
  573.     The    Transmit function on the sub-menu lets    you start talking to the modem.
  574.     If you don't see it    when you expect    to, you    forgot to load the UART, or you
  575.     are     alreading   transmitting.   The  F9  key   is    a  shortcut   to  start
  576.     transmission.
  577.  
  578.     When transmitting, the typewriter  keys you    push are sent to  the modem for
  579.     use    as  its    commands  when it  in its  command state,  or for  transmission
  580.     through the     phone line.  Any  characters received    from the modem    will be
  581.     entered into the text at the cursor, except    for:
  582.      null        0    ignored
  583.      bell        7    audible    signal
  584.      backspace  8    erase last character
  585.      tab        9    skip to    next tab
  586.      line feed 10    ignored
  587.      return       13    split line
  588.      end file  26    ignored
  589.     When you want to  leave communications, use    one of the  cursor control keys
  590.     or Esc.  (PgUp and    PgDn do    not interrupt communications).    The  F9    key has
  591.     the    same effect as this menu option.
  592.  
  593.     The    resend option  causes OmniEdit to start    the transmission  with the same
  594.     captured lines used    before.     This may  be helpful when trying to repeatedly
  595.     dial a busy    phone.
  596.  
  597.     In    systems     in which  your     telephone  mouthpiece    is active  during  data
  598.     communication, be sure to keep it far away from your keyboard and speaker.
  599.  
  600.  
  601.       =============     Uploading and Downloading Files  ================
  602.  
  603.     OmniEdit can transmit and receive files using the Xmodem protocol.    Sending
  604.     files to  another computer is  called uploading when you  send a file  to a
  605.     central computer,  and downloading when you     receive a file    from  a    central
  606.     computer.    To  transmit  files, establish    communication  with  the  other
  607.     computer  at the  other  end  using    the  procedure    above.     Get the  other
  608.     computer ready  to accept  Xmodem commands in  either direction,  using the
  609.     facilities of the  system you are connected     to.  Then get to  the sub-menu
  610.     with F1 and    use the    Xmodem menu function  to upload    or download, or    use the
  611.     Directory function,     for uploading    (send) only.   Once you     push enter  to
  612.     start the  transmission, you will return  to the editing screen,  where you
  613.     may     use OmniEdit  as  an  editor.    The  transmission  takes  place    in  the
  614.     background,    and you    see  only an x at the bottom of    the  screen to tell you
  615.     that the transmission is in    progress.   The    fields normally    giving the line
  616.     and    column    number are  replaced by     the Xmodem  block and    retry counters.
  617.     When the x flag goes away, the transmission    is complete.
  618.  
  619.  
  620.  
  621.  
  622.     Copyright 1985 by Robert T McQuaid.                     page 4
  623.     OmniEdit                              Starting OmniEdit
  624.  
  625.  
  626.  
  627.     The    DOS command  omni, or omni filespec,  available    when you have  the file
  628.     omni.com on    your  disk, invokes OmniEdit.  Here filespec is     defined in the
  629.     DOS    Commands  chapter of the IBM  manual for DOS.    When you do not     have a
  630.     filespec on     the omni command,  OmniEdit will  resume editing the  file you
  631.     were working on the     last time you left OmniEdit.  When you     do not    want to
  632.     edit that file, use    the command omni *.
  633.  
  634.     The    files  edited are DOS  text files with lines  of up to    255 characters.
  635.     OmniEdit requires a     computer with a disk  drive, 192k bytes of  memory and
  636.     DOS.   The displays     look  best  with the  IBM  monochrome    adapter    or  the
  637.     enhanced graphics adapter.
  638.  
  639.  
  640.  
  641.     Copyright 1985 by Robert T McQuaid.                     page 5
  642.     OmniEdit                                Status line
  643.     
  644.  
  645.     The    status line at the bottom of the OmniEdit screen shows,    left to    right:
  646.  
  647.     - Search word, or the last few characters transmitted.
  648.  
  649.     - the date and time, when the clock    menu option is on.
  650.  
  651.     - The cursor line  and column numbers.  During Xmodem  transfer, this shows
  652.       the line number and retry    count in the Xmodem file.
  653.  
  654.     - The name OmniEdit.
  655.  
  656.     - A    small dot that appears when OmniEdit is    waiting    for you.
  657.  
  658.     - Flags:
  659.       e      when you have    made changes that may be reversed with Ctrl-F6.
  660.       o      when you are in overstrike mode.
  661.       r      when the cursor up and down keys hug the right end of    the line.
  662.       t      when you are transmitting through the    UART.
  663.       u      when an exact    copy of    the text is in a DOS file.
  664.       x      when an Xmodem transfer is in    progress.
  665.       C      Caps Lock.
  666.       F      (flashing) when a function has been refused because memory is    full.
  667.       N      Num Lock.
  668.       S      Scroll Lock.
  669.  
  670.     - The name of  the file you    are editing,  or an asterisk (*)  when there is
  671.       none.
  672.  
  673.  
  674.     Copyright 1985 by Robert T McQuaid.                     page 6
  675.     OmniEdit                            Command    summary
  676.  
  677.  
  678.     Here are the keystrokes to do some common functions:
  679.  
  680.     tab                 tab, Shift-tab.
  681.  
  682.     beginning of line         Home.
  683.     beginning of screen         push Home a second    time.
  684.     previous screen         push Home a third time.
  685.     beginning of section     Ctrl-Home.
  686.     beginning of document    hold down Ctrl-Home.
  687.  
  688.     end    of line             End.
  689.     end    of screen         push End a    second time.
  690.     end    of next    screen         push End a    third time.
  691.     end    of section         Ctrl-End.
  692.     end    of document         hold down Ctrl-End.
  693.  
  694.     break a line into two    Enter.
  695.     join two lines into    one  with cursor at left margin, backspace.
  696.     overwrite text         push Ins, then type in text.
  697.     delete characters         backspace or Del.
  698.  
  699.     get    to menu             Esc, or F1    for sub-menu.
  700.     search for word         F3.
  701.     set    search word         Ctrl-F1 or    Ctrl-F2, then key in,
  702.                    or put cursor on    word or    number,    then Ctrl-F4.
  703.     global change         set search    with Ctrl-F1 or    Ctrl-F2    or Ctrl-F4,
  704.                    then use    sub-menu, F1.
  705.     limit scope    of change    put section marks around change area with F5.
  706.  
  707.     move lines             repeat Ctrl-PgUp or Ctrl-PgDn, move cursor, +
  708.     duplicate lines         same as above, but    use - before +
  709.     delete line             Ctrl-PgUp    Ctrl-F5.
  710.     delete several lines     repeat Ctrl-PgUp or Ctrl-PgDn, then Ctrl-F5.
  711.     delete large section     push F5 at    start and end, then Ctrl-F9 Ctrl-F5.
  712.     duplicate text         Ctrl-PgUp or CtrlPgDn, then - and +
  713.  
  714.     delete area             repeat Ctrl-left or Ctrl-right,
  715.                    then Ctrl-PgUp or Ctrl-PgDn, then Ctrl-F5.
  716.     move area             repeat Ctrl-left or Ctrl-right,
  717.                    then Ctrl-PgUp or Ctrl-PgDn,
  718.                    then move cursor    and +
  719.     duplicate area         same as above, but    push - before +
  720.  
  721.     calculate             F2.
  722.     add    column             capture with Ctrl-right or    Ctrl-Left,
  723.                    then Ctrl-PgUp or Ctrl-PgDn, then F2 and    +
  724.  
  725.     undo edit to line         Ctrl-F6.
  726.     recover deleted text     use sub-menu, F1.
  727.  
  728.     sort lines             position cursor at    key column,
  729.                    Ctrl-PgUp or Ctrl-PgDn to capture lines,
  730.                    F1, move    cursor to sort,    Enter, Del.
  731.  
  732.     combine files         read one file, put    the cursor where you want
  733.                    the other, at menu use directory    to read
  734.                    the second file.
  735.     see    time of    day         screen menu function.
  736.     remove snow    on monitor   screen menu function.
  737.     change screen colors     screen menu function.
  738.     remember options         Profile on    main menu.
  739.     help             Help menu functions, or Novice help.
  740.     read after sundown         Help light    bulb.
  741.  
  742.     layout pages         Put section markers at the    beginning and end of
  743.                  the file with F5.    Put heading lines after    the
  744.                  first section mark    followed by a null line    (one
  745.                  with no characters, not even spaces) and put
  746.                  footing lines just    before the last    section    mark
  747.                  preceded by a null    line.  At the sub-menu,    use
  748.                  paginate.
  749.  
  750.     number pages         Follow instructions above,    but put    a page number
  751.                  in    the heading or footing with some neighboring
  752.                  characters.  At Paginate in the sub-menu, type in
  753.                  the first page number with    the same neighboring
  754.                  characters    as the context.     For this manual, for
  755.                  example, the context is " page 1",    with a space
  756.                  before the    p.  Then use paginate once for each
  757.                  section.
  758.     
  759.     Copyright 1985 by Robert T McQuaid.                     page 7
  760.     OmniEdit                           Operating considerations
  761.  
  762.     The    OmniEdit package contains the executable  file omni.com    and the    manual,
  763.     omni.txt.
  764.  
  765.     For    the benefit of users who may  want to change the operating environment,
  766.     here is a  list of resources used  by OmniEdit.  The entire     omni.com file,
  767.     including  the  program  segment  prefix,    remains     unchanged  in    memory.
  768.     OmniEdit modifies  the cells for  interrupt    3, 36,    134 to 209,  and during
  769.     communication, 11 or 12.  To avoid conflict    with Sidekick, the service code
  770.     for    interrupts 11 and 12 does  not allow interrupts.  The intra-application
  771.     area of  memory, locations 1264  to    1279, stores  the edit file  name.  The
  772.     area from the end of the loaded com    file to    the end    of memory, found in the
  773.     second word    of the    program    segment    prefix,    is work    space.     The lower part
  774.     is used first, so that the resident    part of    command.com is left undisturbed
  775.     as long as possible.
  776.  
  777.     OmniEdit calls on DOS or BIOS services for the following purposes:
  778.     int.ah       purpose
  779.     16           change cursor and sound speaker.
  780.     17           equipment, to know which screen adapter to use.
  781.     18           keyboard input.
  782.     32           termination.
  783.     33           DOS function    call.
  784.     33.2       abort message.
  785.     33.14       highest drive number.
  786.     33.(17,18,26)  for reading directories.
  787.     33.25       current drive.
  788.     33.37       set interrupt vectors 10, 11, 27 and    36.
  789.     33.(42,44)       date    and time for clock display, cursor speed and xmodem
  790.            protocol timeout.
  791.     33.59       change directory.
  792.     33.(60-64)       file    input and output, including printer.
  793.     33.71       display of directory    path.
  794.  
  795.     The    screen    text is    written     directly to  the screen buffer,  creating snow
  796.     when using    the IBM    color  graphics    adapter.   The UART is    loaded directly
  797.     through the    port  addresses    found in the  BIOS table at location  640.  The
  798.     calculator patches the Num Lock indicator  at location 1047.  No interrupts
  799.     or service    calls other than  the ones alluded  to in these     paragraphs are
  800.     used.
  801.  
  802.     Please send    comments, suggestions, or imprecations    to the author, Robert T
  803.     McQuaid,  Quaid  Software Limited,    45  Charles  Street East  Third     Floor,
  804.     Toronto Ontario M4Y    1S2.
  805.  
  806.     Copyright 1985 by Robert T McQuaid.                     page 8
  807.     OmniEdit                                   Glossary
  808.  
  809.     Here is a  list of technical terms    used in    this manual.   We exclude words
  810.     used in a sense  in    common use by laymen, terms  defined where they    appear,
  811.     the    names of keys on the IBM  personal computer keyboard, and terms    used in
  812.     the    operating considerations section.
  813.     
  814.  
  815.     backspace  The key on  the IBM Personal Computer keyboard  labeled with the
  816.            left arrow, just     above the Enter key.    This is    not the     key in
  817.            the numeric pad marked with the 4.
  818.  
  819.     capture    A part of the editing text that can move    with the cursor.
  820.  
  821.     communication
  822.            A process  in which  a computer    sends and  receives information
  823.            from another device over    a telephone line.
  824.  
  825.     current directory
  826.            This is    where DOS  looks for files  when you  do not  specify a
  827.            directory.
  828.  
  829.     cursor     A mark identifying a place on the screen    where action may occur.
  830.  
  831.     default drive
  832.            The drive DOS uses for files, when you don't specify one.
  833.  
  834.     DOS           Disk Operating System, a    product    acquired  by most owners of the
  835.            IBM Personal  Computer, that  provides many  services needed  to
  836.            make practical use of the computer.
  837.  
  838.     edit       Making changes to a file.
  839.  
  840.     file       A place for permanent storage of     information.  Things stay in a
  841.            file until you do something to change its contents.
  842.  
  843.     IBM           International Business Machines,    a company that sells computers.
  844.  
  845.     interrupt  A process in which a computer is     diverted for a    short period of
  846.            time to service an urgent need.
  847.  
  848.     modem      A device     placed    between    a computer  and    a phone     line, allowing
  849.            the computer to send and    receive    information on the line.
  850.  
  851.     memory     The part     of a computer    system that  stores things in  the most
  852.            readily available form.    Memory sizes are measured in bytes.
  853.  
  854.     menu       A display of options, allowing you to select the    one you    want by
  855.            pointing    to it.
  856.  
  857.     port       A  facility in  a computer  system capable  of accomodating  the
  858.            attachment of an    external device.
  859.  
  860.     protocol   A set of    conventions giving  meaning to data transferred    between
  861.            systems.
  862.  
  863.     profile    A set  of options  retained from    one  invocation    of  OmniEdit to
  864.            another.
  865.  
  866.     ruler      A graduated  marker used    to measure  the    position of  columns on
  867.            the screen.
  868.  
  869.     scroll     Used as a verb,    meaning    to move    the text displayed  on a screen
  870.            up or down, losing some text at one end,    and bring new text into
  871.            view at the other end.
  872.  
  873.     section    The part    of the text between two    section    marks.
  874.  
  875.     serial port
  876.            A port on  which    signals    can be    sent between a computer     and an
  877.            external    device.      The signals  at a  serial port  conform to  a
  878.            standard     called     RS-232.  The  computer     side  of the  port  is
  879.            usually a UART, and the external    side is    usually    a modem.
  880.  
  881.     text       In this    manual text  refers to    the lines  of text  retained by
  882.            OmniEdit    in the internal    memory of the computer.
  883.  
  884.     text file  A term used in the IBM manuals to described files organized with
  885.            text lines as their contents.
  886.  
  887.     UART       A computer component used to operate  a serial port, and    through
  888.            it, a communications line.
  889.  
  890.     Xmodem     A protocol in  common use with micro-computers  for sending data
  891.            over phone lines.
  892.  
  893.     Copyright 1985 by Robert T McQuaid.                     page 9
  894.